Skip to content
This repository was archived by the owner on Sep 10, 2025. It is now read-only.

Move .lintrunner.toml to top-level directory and include basic linting instructions in CONTRIBUTING.md #1258

Merged
merged 1 commit into from
Oct 3, 2024
Merged

Move .lintrunner.toml to top-level directory and include basic linting instructions in CONTRIBUTING.md #1258

merged 1 commit into from
Oct 3, 2024

Conversation

@vmpuri
Copy link
Contributor

@vmpuri vmpuri commented Oct 3, 2024

Lintrunner is currently broken since the .lintrunner.toml was moved to the install directory.

This PR updates the necessary paths & moves .lintrunner.toml back to the top-level directory so that lint changes can be applied.

I also provide basic instructions on linter installation & usage in the CONTRIBUTING.md.

Tested using a fresh venv as follows:

python3 -m venv .venv                            
source .venv/bin/activate
./install/install_requirements.sh

pip3 install -r install/requirements-lintrunner.txt

(.venv) puri@puri-mac torchchat % lintrunner -a
Warning: Could not find a lintrunner config at: '.lintrunner.private.toml'. Continuing without using configuration file.
ok No lint issues.
Successfully applied all patches.

@vmpuri vmpuri requested a review from Jack-Khuu October 3, 2024 09:18
@vmpuri vmpuri self-assigned this Oct 3, 2024
@pytorch-bot
Copy link

pytorch-bot bot commented Oct 3, 2024 •
edited
Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchchat/1258

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit f8db598 with merge base 34d6831 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Oct 3, 2024
@vmpuri vmpuri requested a review from byjlw October 3, 2024 09:19
@vmpuri vmpuri marked this pull request as ready for review October 3, 2024 09:20
@Jack-Khuu
Copy link
Contributor

Jack-Khuu commented Oct 3, 2024

Thanks for doing this

This seems fishy; might be an existing error if you've already moved the file back
Warning: Could not find a lintrunner config at: '.lintrunner.private.toml'. Continuing without using configuration file.

@vmpuri vmpuri merged commit fc96127 into main Oct 3, 2024
52 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@byjlw byjlw Awaiting requested review from byjlw

1 more reviewer

@Jack-Khuu Jack-Khuu Jack-Khuu approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@vmpuri vmpuri

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vmpuri @Jack-Khuu @facebook-github-bot